<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IBrowserManager,mx.managers.IBrowserManager,base,fragment,title,url,init,initForHistoryManager,setFragment,setTitle" name="keywords">
<title>mx.managers.IBrowserManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IBrowserManager - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/managers/IBrowserManager.html&amp;mx/managers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IBrowserManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IBrowserManager"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.managers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IBrowserManager extends <a href="none">flash.events.IEventDispatcher</a></td>
</tr>
</table>
<p></p>
  The interface that the shared instance of the BrowserManager
  implements. Applications listen for events,
  call methods, and access properties on the shared instance
  which is accessed with the <code>BrowserManager.getInstance()</code> method.
 
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../managers/BrowserManager.html" target="">mx.managers.BrowserManager</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#base">base</a> : String<div class="summaryTableDescription">[read-only]
      The portion of current URL before the '#' as it appears 
      in the browser address bar.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#fragment">fragment</a> : String<div class="summaryTableDescription">[read-only]
      The portion of current URL after the '#' as it appears 
      in the browser address bar.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#title">title</a> : String<div class="summaryTableDescription">[read-only]
      The title of the application as it should appear in the
      browser history.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#url">url</a> : String<div class="summaryTableDescription">[read-only]
      The current URL as it appears in the browser address bar.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#init()">init</a>(value:String = null, title:String = null):void</div>
<div class="summaryTableDescription"> 
      Initializes the BrowserManager.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initForHistoryManager()">initForHistoryManager</a>():void</div>
<div class="summaryTableDescription"> 
      Initializes the BrowserManager.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setFragment()">setFragment</a>(value:String):void</div>
<div class="summaryTableDescription"> 
      Changes the fragment of the URL after the '#' in the browser.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setTitle()">setTitle</a>(value:String):void</div>
<div class="summaryTableDescription"> 
      Changes the text in the browser's title bar.</div>
</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:browserURLChange">browserURLChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when the URL is changed
  by the browser.</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:change">change</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when the URL is changed either
  by the user interacting with the browser, invoking an
  application in AIR, or by setting the property programmatically.</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:urlChange">urlChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when the URL is changed
  by the application.</td><td class="summaryTableOwnerCol">IBrowserManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="base"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">base</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>base:String</code>&nbsp;&nbsp;[read-only]<p>
      The portion of current URL before the '#' as it appears 
      in the browser address bar.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get base():String</code>
<br>
</div>
<a name="fragment"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fragment</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>fragment:String</code>&nbsp;&nbsp;[read-only]<p>
      The portion of current URL after the '#' as it appears 
      in the browser address bar. Use the <code>setURLFragment()</code> method to change this value.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get fragment():String</code>
<br>
</div>
<a name="title"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">title</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>title:String</code>&nbsp;&nbsp;[read-only]<p>
      The title of the application as it should appear in the
      browser history.
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get title():String</code>
<br>
</div>
<a name="url"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>url:String</code>&nbsp;&nbsp;[read-only]<p>
      The current URL as it appears in the browser address bar.  
     </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get url():String</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="init()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">init</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function init(value:String = null, title:String = null):void</code><p> 
      Initializes the BrowserManager. The BrowserManager will get the initial URL. If it
      has a fragment, it will dispatch a <code>BROWSER_URL_CHANGE</code> event.
           This method sets the value of the <code>Application.application.historyManagementEnabled</code>
      property to <code>false</code> because the HistoryManager generally interferes with your
      application's handling of URL fragments.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The fragment to use if no fragment is in the initial URL.
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">title</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The title to use if no fragment is in the initial URL.
     </td>
</tr>
</table>
</div>
<a name="initForHistoryManager()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initForHistoryManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function initForHistoryManager():void</code><p> 
      Initializes the BrowserManager. The HistoryManager calls this method to
      prepare the BrowserManager for further calls from the HistoryManager. You cannot use 
      the HistoryManager and call the <code>setFragment()</code> method from the application.
      As a result, the <code>init()</code> method usually sets 
      the value of the <code>Application.application.historyManagementEnabled</code> property to <code>false</code> to disable
      the HistoryManager.
     </p></div>
<a name="setFragment()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setFragment</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setFragment(value:String):void</code><p> 
      Changes the fragment of the URL after the '#' in the browser.
      An attempt will be made to track this URL in the browser's
      history.
           </p><p>If the title is set, the old title in the browser is replaced
      by the new title.</p>
           <p>To store the URL, a JavaScript
      method named <code>setBrowserURL()</code> will be called.
      The application's HTML wrapper must have that method which
      must implement a mechanism for taking this
      value and registering it with the browser's history scheme
      and address bar.</p>
           <p>When set, the <code>APPLICATION_URL_CHANGE</code> event is dispatched. If the event
      is cancelled, the <code>setBrowserURL()</code> method will not be called.</p>
     <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:String</code></td>
</tr>
</table>
</div>
<a name="setTitle()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setTitle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setTitle(value:String):void</code><p> 
      Changes the text in the browser's title bar.
      This method does not affect the browser's history.
     </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:String</code></td>
</tr>
</table>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:browserURLChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">browserURLChange</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../events/BrowserChangeEvent.html"><code>mx.events.BrowserChangeEvent</code></a>
<br>
<span class="label">BrowserChangeEvent.type property = </span><a href="../events/BrowserChangeEvent.html#BROWSER_URL_CHANGE"><code>mx.events.BrowserChangeEvent.BROWSER_URL_CHANGE</code></a>
<br><p>
  Dispatched when the URL is changed
  by the browser.
   </p><p>
      The <code>BrowserChangeEvent.BROWSER_URL_CHANGE</code> constant defines the value of the 
      <code>type</code> property of the event object for a <code>browserURLChange</code> event.
     
      </p><p>The properties of the event object have the following values:</p>
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the 
           event listener that handles the event. For example, if you use 
           <code>myButton.addEventListener()</code> to register an event listener, 
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>lastURL</code></td><td>The previous value of the BrowserManager's
           <code>url</code> property.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event; 
           it is not always the Object listening for the event. 
           Use the <code>currentTarget</code> property to always access the 
           Object listening for the event.</td></tr>
         <tr><td><code>url</code></td><td>The new value of the BrowserManager's
           <code>url</code> property.</td></tr>
      </table>
           </div>
<a name="event:change"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">change</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>flash.events.Event</code></a>
<br>
<p></p><p>
  Dispatched when the URL is changed either
  by the user interacting with the browser, invoking an
  application in AIR, or by setting the property programmatically.
   </p></div>
<a name="event:urlChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">urlChange</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../events/BrowserChangeEvent.html"><code>mx.events.BrowserChangeEvent</code></a>
<br>
<span class="label">BrowserChangeEvent.type property = </span><a href="../events/BrowserChangeEvent.html#URL_CHANGE"><code>mx.events.BrowserChangeEvent.URL_CHANGE</code></a>
<br><p>
  Dispatched when the URL is changed
  by the application.
   </p><p>
      The <code>BrowserChangeEvent.URL_CHANGE</code> constant defines the value of the 
      <code>type</code> property of the event object for a <code>urlChange</code> event.
     
      </p><p>The properties of the event object have the following values:</p>
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the 
           event listener that handles the event. For example, if you use 
           <code>myButton.addEventListener()</code> to register an event listener, 
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>lastURL</code></td><td>The previous value of the BrowserManager's
           <code>url</code> property.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event; 
           it is not always the Object listening for the event. 
           Use the <code>currentTarget</code> property to always access the 
           Object listening for the event.</td></tr>
         <tr><td><code>url</code></td><td>The new value of the BrowserManager's
           <code>url</code> property.</td></tr>
      </table>
           </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
